home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / olhm1_2.zip / OLHM.DOC < prev    next >
Text File  |  1993-02-26  |  16KB  |  470 lines
  1.  
  2.  
  3.  
  4.  
  5.                   BBS Technologies 
  6.                   presents
  7.  
  8.            ***   Online Hangman version 1.2   ***
  9.  
  10.          
  11.          (C) Copyright 1992, 1993 BBS Technologies
  12.                  All Rights Reserved
  13.   
  14.  
  15.  
  16.  
  17.           
  18.     ***  Online Hangman supports the following Door Information files  ***
  19.  
  20.      DOOR.SYS, USERINFO.DAT, PCBOARD.SYS, USERS.SYS, CALLINFO.BBS
  21.             DORINFO.DEF, SFDOORS.DAT, CHAIN.TXT
  22.     
  23.     
  24.     
  25.     
  26.     
  27.     *****     For Technical support please call our Support BBS    *****
  28.           and leave a message in the Doors Support Conference
  29.                 BBS (209) 222-0227
  30.  
  31.  
  32.           This Software is *NOT*  Freeware or Public Domain
  33.           Please register it within (2) weeks if you like it.
  34.  
  35.               
  36.               
  37.               Documentation version 1.2
  38.   
  39.  
  40.   
  41.   
  42.   *************************************************************************
  43.   * By using this software you agree to the terms of the Software License *
  44.   * agreement, Limited Warranty on Diskettes and Disclaimer of Warranty.  *
  45.   *************************************************************************
  46.  
  47.  
  48.               SOFTWARE LICENSE AGREEMENT
  49.               --------------------------
  50.  
  51.  This software is LICENSED not sold.
  52.  
  53.  
  54.  
  55.  You may:
  56.  --------
  57.  (1) Make as many backups as you see fit to protect your investment.
  58.  
  59.  (2) Use this software on as many nodes as you like. (As long as it remains
  60.      on (1) BBS only). If you run more than one BBS please purchase additional
  61.      license agreements for each BBS).
  62.  
  63.  Besides the above rights you have no other rights to the software, implied
  64.  or otherwise.
  65.  
  66.  You may NOT:
  67.  ------------
  68.  (1) Reverse-Engineer, Decompile or Alter the software in any way.
  69.  
  70.  (2) Rent, Lease or Lend the software you have licensed.
  71.  
  72.  (3) Give out or let anybody use your software activation code.
  73.  
  74.   
  75.  
  76.   If you breach this License Agreement BBS Technologies and/or
  77.   Studio 7 Software will terminate your license agreement and all
  78.   software and manuals must be returned back to BBS Technologies
  79.   and use of the software must be terminated.
  80.  
  81.  
  82.  
  83.  
  84.             LIMITED WARRANTY OF DISKETTE(S)
  85.             ------------------------------
  86.  
  87.  BBS TECHNOLOGIES WARRANTS TO THE ORIGINAL LICENSEE OF A REGISTERED PRODUCT
  88.  THAT THE PROGRAM DISKETTE(S) ON WHICH THE PROGRAM IS RECORDED WILL BE FREE
  89.  FROM DEFECTS IN MATERIALS AND WORKMANSHIP UNDER NORMAL USE FOR A PERIOD OF
  90.  NINETY (90) DAYS FROM THE DATE OF DELIVERY. BBS TECHNOLOGIES ENTIRE
  91.  LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL BE REPLACEMENT OF THE DISKETTE(S)
  92.  NOT MEETING BBS TECHNOLOGIES LIMITED WARRANTY IF RETURNED TO 
  93.  BBS TECHNOLOGIES WITHIN THE (90) DAY PERIOD.
  94.  
  95.                DISCLAIMER OF SOFTWARE WARRANTY
  96.                -------------------------------
  97.  
  98.  THIS SOFTWARE PRODUCT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. THE
  99.  ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE OF THIS SOFTWARE IS ASSUMED
  100.  BY YOU (NOT BBS TECHNOLOGIES). BBS TECHNOLOGIES DOES NOT WARRANT, GUARANTEE,
  101.  OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, RESULTS OF, 
  102.  MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE OF THIS SOFTWARE. SHOULD THE
  103.  SOFTWARE PROVE DEFECTIVE, YOU (NOT BBS TECHNOLOGIES) ASSUME THE ENTIRE COST
  104.  OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION EVEN IF BBS TECHNOLOGIES
  105.  HAS BEEN NOTIFIED OF A DEFECT(S). BBS TECHNOLOGIES DOES NOT WARRANT,
  106.  GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR RESULTS OF
  107.  THE USE OF THE SOFTWARE IN TERMS OF CORRECTNESS, ACCURACY, RELIABILITY, OR
  108.  OTHERWISE. YOU RELY ON THE SOFTWARE AND RESULTS SOLELY AT YOUR OWN RISK.
  109.  BBS TECHNOLOGIES WILL NOT BE LIABLE FOR ANY DAMAGES, INCLUDING BUT NOT
  110.  LIMITED TO SYSTEM DAMAGE, SERVICE, REPAIR, CORRECTION, LOSS OF PROFIT,
  111.  LOST SAVINGS, OR ANY OTHER INCIDENTAL, CONSEQUENTIAL, OR SPECIAL DAMAGES
  112.  OF ANY NATURE WHATSOEVER RESULTING FROM THE USE OR THE INABILITY TO USE
  113.  THIS SOFTWARE.
  114.  
  115.  THE DISCLAIMER OF WARRANTY SHALL BE GOVERNED BY THE LAWS OF 
  116.  THE STATE OF CALIFORNIA.
  117.  
  118.  
  119.  
  120.  
  121.  
  122.            *** Online Hangman Door Description ***
  123.  
  124.  The object of Online Hangman is to guess the mystery word before getting
  125.  Hung!  In the Registered version of Online Hangman the Sysop can define
  126.  up to 30 different categories of words and also define all the words!
  127.  The un-registered version comes with 3 set categories and the words are
  128.  already defined.
  129.  
  130.  Points are figured as follows:
  131.  
  132.  New callers and callers with a score of 0 are given 120 points when they
  133.  enter the door.  When a caller exits the door with a score that is
  134.  greater than 0 it will be retained for the next time the caller plays
  135.  the game.  (* assuming the game hasn't been reset *)
  136.  If a caller loses all of his points the game will end and he will be 
  137.  returned back to the BBS.
  138.  
  139.  When a letter is guessed and it is correct you win 10 points, if the guess 
  140.  is wrong you lose 10 points.  You get 6 wrong guesses before you are HUNG!
  141.  
  142.  If you attempt a Guess at the whole word using [$] Guess Word command and
  143.  are right you will get 25 points, if you are wrong you will lose 5 points.
  144.  You can only use the [$] Guess Word command 3 times per word, on your
  145.  3rd wrong try you will be given a whole new word.
  146.  
  147.  
  148.  
  149.  
  150.  Commands that can be used during the game are:    
  151.  
  152.     [?]=Category
  153.     Allows caller to choose which category he wants the words 
  154.     to be taken from.
  155.   
  156.     [#]=Color On/Off Toggle.
  157.     Allows caller to turn color on and off while in the door.
  158.     
  159.     [!]=Quit Game
  160.     Allows caller to see bulletin if desired, and then exits back to
  161.     the BBS.
  162.  
  163.     [&]=Bulletin  
  164.     Allows caller to see the top 10 highest scores.
  165.  
  166.     [$]=Guess Word  
  167.     Allows caller to try to guess the whole word.
  168.  
  169.     [@]=Help Me  
  170.     Gives caller instructions and information about Online Hangman.
  171.  
  172.  
  173.     
  174.  
  175.                  
  176.                  
  177.                  *** FILES ***
  178.  
  179.  The following files are included on the disk or in the OLBJWC.ZIP file
  180.  you received:
  181.  
  182.       olhm.doc     <--- you are reading it now    
  183.       olhm.exe     <--- executable program for Online Hangman
  184.      olhm1.cfg     <--- sample configuration file for Wildcat! BBS
  185.      door#.run     <--- sample DOOR#.RUN file to run Online Hangman
  186.    categor.eis     <--- must have in door directory
  187.    *******.dat     <--- all .dat files must be in door directory
  188.   hmconfig.exe     <--- makes OLHM#.CFG configuration file(s)
  189.   orderfrm.txt     <--- Online Hangman order form
  190.    resethm.exe     <--- clears all scores out of high score bulletin
  191.             (*** Registered version ONLY ***)
  192.    makecat.exe     <--- Allows Sysop to define up to 30 different 
  193.             categories and to define all words for the
  194.             categories. (*** Registered version ONLY***)
  195.  
  196.  
  197.  Online Hangman supports a wide variety of BBS Software, the following
  198.  is a list of the Door Information Files supported:  DOOR.SYS, 
  199.  USERINFO.DAT, PCBOARD.SYS, USERS.SYS, CALLINFO.BBS, DORINFO.DEF,
  200.  SFDOORS.DAT, CHAIN.TXT
  201.  
  202.  This documentation will walk you through the steps of setting up 
  203.  Online Hangman for the Wildcat! BBS Software as a (SHELL to DOS Door).
  204.  For setting up Doors on your particular BBS software please refer to
  205.  your software manual.
  206.  
  207.  *** No matter what BBS software you are running you can still use
  208.  *** the Online Hangman configuration utility to make your node 
  209.  *** configuration file(s).
  210.  
  211.  If you have never set up a door or would like to set this door up as a
  212.  (TERMINATE for DOORS) door PLEASE READ the section on doors in your
  213.  Wildcat! manual.
  214.  
  215. ----------------------------------------------------------------------------
  216.  
  217.  Step (1):  Make a directory on your hard disk for Online Hangman and
  218.         copy all the files from the diskette to your new 
  219.         sub-directory.
  220.         
  221.         For our example we will use a sub-directory called OLHM
  222.  
  223.         If you downloaded Online Hangman from BBS Technologies
  224.         support BBS, copy OLHM1_2.ZIP to its own directory and then
  225.         use PKunzip to uncompress the files.
  226.  
  227. ----------------------------------------------------------------------------
  228.  
  229.  
  230.  Step (2):  Type HMCONFIG to start the Online Hangman Configuration 
  231.         Utility. The Configuration program will make a file or 
  232.         files, depending on how many nodes you configure. The file(s)
  233.         will tell Online Hangman the information it needs to 
  234.         run on your system.  It will make file(s) called OLHM#.CFG 
  235.         where # will be replaced by the node number you are configuring.
  236.   
  237.   
  238.   (A) Which Node are you making this Configuration File for:
  239.       
  240.       If you have a Wildcat! Single Line BBS just type 1, if you have
  241.       a Wildcat! 1-10  or 1-250 Node version and for example you have 
  242.       10 Nodes running you will want to make a Configuration file for 
  243.       each node. At the end of the Configuration program it will 
  244.       automatically ask you if you would like to configure extra nodes.
  245.       
  246.   (B) Complete Name of your Door Information File Including Drive
  247.       and Full path:
  248.  
  249.       Type in the path to the node directory that you are making the
  250.       Configuration file for.  Example: If it was Node 1 you would type
  251.       
  252.       C:\WC30\WCWORK\NODE1\DOOR.SYS
  253.       
  254.       Wildcat! 3.xx uses DOOR.SYS for its Door information file, so always 
  255.       include DOOR.SYS at the end of your path.
  256.  
  257.    ** Please see your BBS manual for information on what Door Information
  258.       file your BBS uses.
  259.  
  260.  
  261.   (C) Your BBS Name:
  262.       Type Your BBS name here
  263.  
  264.   (D) First Name:
  265.       Type your First name  (This must be the same name given to the 
  266.       BBS Technologies Sales person or the name on your registration 
  267.       form or Online Hangman will NOT be fully activated)
  268.  
  269.   (E) Last Name:
  270.       Type your Last name   (This must be the same name given to the 
  271.       BBS Technologies Sales person or the name in your registration
  272.       form or Online Hangman will NOT be fully activated)
  273.   
  274.   (F) Software Activation Code:
  275.       Type in the Activation Code given to you by BBS Technologies
  276.       (If the wrong Activation Code is put in, Online Hangman will                
  277.       NOT be fully activated.)
  278.       ** For unregistered version you can leave this field blank.                
  279.               
  280.    After the Activation Code question the Config program will ask if
  281.    everything is correct, if you made a mistake just type N and you 
  282.    will be able to correct it, or type Y to continue.
  283.               
  284.    The last prompt will ask you if you would like to configure another Node.
  285.    If you are configuring Online Hangman to run on multiple nodes type Y
  286.    and you will continue configuring Nodes 2, 3, 4...etc until you are 
  287.    finished.
  288.  
  289.  
  290.  
  291.  
  292.  
  293. STEP (3)
  294.               
  295.               *** DOOR#.RUN File ***
  296.  
  297.  
  298.     The # symbol in DOOR#.RUN needs to be replaced by the number that you
  299.     want your callers to select to run the door:
  300.        
  301.        Example:  If this is your first door the file should be called   
  302.          DOOR1.RUN  
  303.          
  304.   (A)  Rename the sample DOOR#.RUN file included with this software
  305.        to the door number you want it to be.
  306.  
  307.        Example:  Rename DOOR#.RUN DOOR1.RUN
  308.  
  309.   
  310.   (B)  Copy the DOOR#.RUN file to each Node directory you want to run     
  311.        the door from.
  312.  
  313.        Example: Copy DOOR1.RUN C:\WC30\WCWORK\NODE1\DOOR1.RUN   
  314.   
  315.   
  316.   (C)  Edit the DOOR#.RUN in EACH Node directory that you copied it to 
  317.        with your favorite text editor and configure it as follows and 
  318.        then save your changes:
  319.  
  320.  
  321.     cd c:\olhm       <--- Change this line to the directory where you 
  322.               installed Online Hangman
  323.     olhm olhm#.cfg   <--- olhm starts the program and olhm#.cfg is the
  324.               configuation file it needs to run.
  325.               Change the # symbol in the olhm#.cfg to the
  326.               the proper Node number for each directory.
  327.  
  328.               Example: If you are in node 3 change it to
  329.                    
  330.                    olhm olhm3.cfg
  331. -----------------------------------------------------------------------------
  332.  
  333.          **** IMPORTANT NOTE FOR -NON- STANDARD IRQ's: ****
  334.  
  335.          Supports COM 1 to 4 on the standard IRQ's
  336.            Com1/Com3 = IRQ4 and Com2/Com4 = IRQ3
  337.  
  338.            
  339.  If you wish to use a non-standard IRQ, add the IRQ number after the 
  340.  configuration filename. For example if you want to use Com1 and IRQ5. 
  341.  The command line passed to your door would be:
  342.  
  343.                  OLHM OLHM#.CFG /5 
  344.  
  345.    The /5 tells the DOOR to use IRQ5 rather than the standard IRQ4 that is
  346.    normally used with COM1. No /x parameter is needed for the standard IRQ's.
  347.  
  348.  
  349.  
  350. Step (4)                                
  351.  
  352.       Edit your DOORS.BBS and/or your DOORS.SCR with WCDRAW.EXE 
  353.       (Wildcat! screen designer) or your favorite editor and add 
  354.       Online Hangman to the display file(s).
  355.       
  356.       DOORS.BBS and DOOR.SCR is the display file(s) that will be seen  
  357.       when the caller selects [D]oors from the Main Menu of your
  358.       Wildcat! BBS.
  359.     
  360.       The file(s) are usually located in the c:\wc30\disp\
  361.       directory.
  362.       
  363.       For more information on display files, consult your Wildcat! manual
  364.  
  365. ----------------------------------------------------------------------------                                
  366. Step (5)                                
  367.                 
  368.     Check Makewild, Wildcat!'s configuration program to make sure                       
  369.     you have "Terminate on Doors and Menu Hooks" set to "N"
  370.     This setting is under General Definition - Part 2 and it is #3
  371.  
  372.     If you want to Terminate on doors, skip this step.
  373.  
  374. ----------------------------------------------------------------------------
  375.                 
  376. Step (6)                                
  377.  
  378.          Have Fun - Your Online Hangman is now ready to GO!!!
  379.                 
  380.                 
  381. ----------------------------------------------------------------------------                                
  382.  
  383.              Fossil Driver Support
  384.  
  385.   Online Hangman has built in support for Fossil drivers!
  386.   To activate fossil driver support, just include /FD on the
  387.   end of the command line that runs the door.
  388.   Example:
  389.  
  390.   OLHM OLHM1.CFG /FD
  391.  
  392.   If no Fossil driver is available, the door will display a message
  393.   to that effect and exit gracefully.
  394.  
  395. ----------------------------------------------------------------------------
  396.  
  397.  
  398.  
  399.  
  400.  
  401.                 DOOR OPERATION
  402.                 --------------
  403.   
  404.   F3   -   Toggles printer On/Off.  (PCBoard Only)
  405.         
  406.   F4   -   Toggles Page Bell On/Off. (PCBoard Only)
  407.         
  408.   F5   -   DOS Shell -  Allows SysOp to drop to DOS from inside the DOOR.
  409.     
  410.   F7   -   Toggles Caller Alarm On/Off.
  411.         
  412.   F8   -   Returns the caller involuntarily back to the BBS
  413.        Without letting them know that the Sysop called them back!
  414.   
  415.   F9   -   Toggles local display On/Off.
  416.        
  417.   F10  -   Activates Sysop CHAT mode within the DOOR.
  418.  
  419.   ESC  -   Deactivates CHAT mode.  DOOR is resumed.
  420.   
  421.   HOME -  HELP key for status line options.
  422.   
  423.   UP   -   Allows the Sysop to temporarily give the caller extra time
  424.        while in the DOOR.  This time is NOT passed to BBS.
  425.   
  426.   DN   -   Allows the Sysop to temporarily subtract time from the
  427.        caller while in the DOOR.  This time is NOT passed to BBS.
  428.   
  429.   ALT-N   Toggle Sysop on next. (PCBoard Only)
  430.  
  431.   ALT-X   BBS will shut down after current caller logs off. (PCBoard Only)
  432.  
  433.  
  434.   
  435.           ******* Reseting Online Hangman Scores *******
  436.   
  437.   
  438.       To clear out all scores out of High Score Bulletin type:
  439.       
  440.       RESETHM.EXE      (*** Registered version ONLY ***)
  441.  
  442.       resethm.exe must be in your Online Hagman sub-directory in order
  443.       to work.
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.                 WATCHDOG/CTTY/ANSI.SYS
  453.                 ----------------------
  454.  
  455.     CTTY and WATCHDOG are not required and should not be used with
  456.     this program.  This door contains its own communication routines
  457.     which monitor the COM port.  If carrier is lost, the door will
  458.     return control back to the BBS. 
  459.     
  460.     ANSI.SYS, or something similar, is required for this door to
  461.     function properly!
  462.  
  463.                  DISTRIBUTION
  464.  
  465.  
  466.           This door may not be distributed as part of any
  467.           commercial application or service without the
  468.           express, written consent of BBS Technologies.
  469.  
  470.